CreateTemplate

Description

call the CreateTemplate interface to create a custom template.

Request Method

POST

Request Path

/apsara/route/ROS/CreateTemplate

Request Parameters Common Parameters

Name	Location	Type	Required	Sample value	Description
TemplateURL	BODY	string	No	oss://ros/template/demo	the location of the file containing the template body. The URL must point to the template located in the Web server (HTTP or HTTPS) or Aliyun OSS bucket (for example, oss:// ros/template/demo, oss:// ros/template/demo?RegionId = cn-hangzhou), the maximum template is 524 and 288 bytes. If the OSS region is not specified, the default is the same as the interface parameter RegionId. description you can specify TemplateBody or TemplateURL parameters, but not at the same time. the maximum length of the URL is: 1024 bytes.
Description	BODY	string	No	It is a demo.	description of the template. The maximum length is 256 characters.
regionId	BODY	string	Yes	No sample value for this parameter.	region id
TemplateName	BODY	string	Yes	MyTemplate	the name of the template. must be no more than 255 characters in length and must start with a number or an English letter, which can contain numbers, English letters, dashes (-), and underscores (_).
TemplateBody	BODY	string	No	{"ROSTemplateFormatVersion":"2015-09-01"}	the structure of the template. The length is 1~524 and 288 bytes. /p> p data-tag = "p" class = "p"> if the length is large, it is recommended to pass the parameters in the request body through HTTP POST + Body Param to avoid the request failure caused by the URL being too long. description you must specify the parameter TemplateBody or TemplateURL, but not at the same time.
version	BODY	string	No	2016-01-01	version of api

Return data

Name	Type	Sample value	Description
RequestID	string	1E3D5A1E0-67CA-43DA-24BC-EAF2D5A1E4DC	Request id

Example

Successful Response example

{
 "RequestID":"1E3D5A1E0-67CA-43DA-24BC-EAF2D5A1E4DC"
}

Failed Response example

{
 "errorSample":
 {
  "resultCode":-1,
  "resultMsg":"system error",
  "result":null
 }

}

---

title: DeleteStack

sidebar_position: 3

DeleteStack

Description

call the DeleteStack interface to delete the resource stack.

Request Method

POST

Request Path

/apsara/route/ROS/DeleteStack

Request Parameters Common Parameters

Name	Location	Type	Required	Sample value	Description
RamRoleName	BODY	string	No	test-role	RAM role name. ROS will play this role to create a resource stack and use the role's credentials to make interface calls on behalf of the user. ROS always uses this role for operations that will take place on the resource stack. As long as the user has the right to operate on the resource stack, even if the user does not have the right to use the role, ROS will use this role to ensure that the role grants minimal permissions. this interface is different from other interfaces. if the user does not specify this value, ROS will not use the role previously associated with the resource stack. If you need to use a role, specify it explicitly. If no role is available, ROS will use temporary credentials generated from your user credentials. The maximum length of the RAM role name is 64 bytes.
regionId	BODY	string	Yes	No sample value for this parameter.	region id
RetainAllResources	BODY	boolean	No	false	whether to keep all resources under the resource stack.
RegionId	BODY	string	Yes	cn-hangzhou	the region ID to which the resource stack belongs.
RetainResources.N	BODY	repeatlist	No	WebServer	the list of resources that need to be kept.
version	BODY	string	No	2016-01-01	version of api
StackId	BODY	string	Yes	4a6c9851-3b0f-4f5f-b4ca-a14bf691****	resource stack ID.

Return data

Name	Type	Sample value	Description
RequestID	string	1E3D5A1E0-67CA-43DA-24BC-EAF2D5A1E4DC	Request id

Example

Successful Response example

{
 "RequestID":"1E3D5A1E0-67CA-43DA-24BC-EAF2D5A1E4DC"
}

Failed Response example

{
 "errorSample":
 {
  "resultCode":-1,
  "resultMsg":"system error",
  "result":null
 }

}